/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package androidx.health.connect.client.records

import androidx.health.connect.client.aggregate.AggregateMetric
import androidx.health.connect.client.records.metadata.Metadata
import androidx.health.connect.client.units.Length
import androidx.health.connect.client.units.meters
import java.time.Instant
import java.time.ZoneOffset

/** Captures the elevation gained by the user since the last reading. */
public class ElevationGainedRecord(
    override val startTime: Instant,
    override val startZoneOffset: ZoneOffset?,
    override val endTime: Instant,
    override val endZoneOffset: ZoneOffset?,
    /** Elevation in [Length] units. Required field. Valid range: -1000000-1000000 meters. */
    public val elevation: Length,
    override val metadata: Metadata = Metadata.EMPTY,
) : IntervalRecord {

    init {
        elevation.requireNotLess(other = MIN_ELEVATION_GAIN, name = "elevation")
        elevation.requireNotMore(other = MAX_ELEVATION_GAIN, name = "elevation")
        require(startTime.isBefore(endTime)) { "startTime must be before endTime." }
    }

    /*
     * Generated by the IDE: Code -> Generate -> "equals() and hashCode()".
     */
    override fun equals(other: Any?): Boolean {
        if (this === other) return true
        if (other !is ElevationGainedRecord) return false

        if (elevation != other.elevation) return false
        if (startTime != other.startTime) return false
        if (startZoneOffset != other.startZoneOffset) return false
        if (endTime != other.endTime) return false
        if (endZoneOffset != other.endZoneOffset) return false
        if (metadata != other.metadata) return false

        return true
    }

    /*
     * Generated by the IDE: Code -> Generate -> "equals() and hashCode()".
     */
    override fun hashCode(): Int {
        var result = elevation.hashCode()
        result = 31 * result + startTime.hashCode()
        result = 31 * result + (startZoneOffset?.hashCode() ?: 0)
        result = 31 * result + endTime.hashCode()
        result = 31 * result + (endZoneOffset?.hashCode() ?: 0)
        result = 31 * result + metadata.hashCode()
        return result
    }

    companion object {
        private val MAX_ELEVATION_GAIN = (1000_000).meters
        private val MIN_ELEVATION_GAIN = (-1000_000).meters

        /**
         * Metric identifier to retrieve the total elevation gained from
         * [androidx.health.connect.client.aggregate.AggregationResult].
         */
        @JvmField
        val ELEVATION_GAINED_TOTAL: AggregateMetric<Length> =
            AggregateMetric.doubleMetric(
                dataTypeName = "ElevationGained",
                aggregationType = AggregateMetric.AggregationType.TOTAL,
                fieldName = "elevation",
                mapper = Length::meters,
            )
    }
}
